/*
 * Copyright 2008 the Breachwalls OSS project and the Others.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
 * either express or implied. See the License for the specific language
 * governing permissions and limitations under the License.
 */
package com.breachwalls.quasar.datatype;

import java.io.Serializable;

import com.breachwalls.quasar.messages.ErrorMessage;
import com.breachwalls.quasar.messages.ErrorMessageList;

/**
 * データタイプインタフェイス.
 * @author todoken
 * @version $Revision: 37 $
 */
public interface Datatype extends Serializable {

    /**
     * データタイプがNULL表現であるか調べる.
     * @return データタイプがNULL表現の場合、TRUEを返す
     */
    boolean isNull();

    /**
     * データタイプのデータ長を取得する.
     * @return データタイプのデータ長
     */
    int length();

    /**
     * データタイプがエラーを持っているか調べる.
     * @return エラーがある場合、TRUEを返す
     */
    boolean hasErrors();

    /**
     * データタイプが持っているエラーメッセージの一覧を取得する.
     * @return エラーメッセージの一覧
     */
    ErrorMessageList getErrorMessages();

    /**
     * データタイプにエラーメッセージを追加する.
     * @param error 追加するエラーメッセージ
     */
    void addErrorMessage(final ErrorMessage error);

    /**
     * データタイプの値の妥当性をチェックする.
     * @return データタイプの値が妥当な場合、TRUEを返す
     */
    boolean validate();

    /**
     * データタイプの値の妥当性をチェックする.
     * @param fieldName データタイプのフィールド名
     * @return データタイプの値が妥当な場合、TRUEを返す
     */
    boolean validate(String fieldName);

}
